Skip to main content

Connecting with GitHub Repositories

The goal of this document​

Here, we are going to connect the vendor called github with the Airbyte then it will redirect the data using the destination of MySQL to OPNBI, User can choose the format of the destination as required, For example from MySQL/ PostgreSQL, etc.

Useful Resources of Airbyte​

Requirements to get the ‘GitHub’ source​

• User should have an account on GitHub if not then signup from the below link: https://github.com/

• User should have the Personal Access Token of GitHub.

Steps to Fetch the Personal API Token from GitHub​

  1. To getch the Access Token of github, you should go to https://github.com/settings/tokens

  2. You need to login with your credentials.

    Github repository

  3. Click on generate token button from top right corner, as shown in figure below:

    Github repository

  4. Once you click on generate token button, the form appear on the screen as shown in the figure below, here user can add required name and select the scopes they want to access through access token:

    Github repository

  5. Now, Add name of token and select the scopes component as per required:

    Github repository

  6. Now, Click on generate token button from end of the form, as shown in the figure below:

    Github repository

  7. After the token gets add on screen, you can copy whole token using COPY icon from beside of the token bar:

    Github repository

Steps to Connect github with OPNBI​

  1. Go to the Airbyte using the below link: https://airbyte.com/

  2. The Airbyte landing screen looks like below:

Docusaurus Slash Introduction

  1. Here We have 3 options on the left, which contain Connections, Sources, and Destination. As per continuing the steps click on the Sources option.

Docusaurus Slash Introduction

  1. To add the github source, click on the New Source button from the Top-right corner.

Docusaurus Slash Introduction

  1. To add Any of the sources here, the user needs to add the properties which are needed from the Airbyte, every source has its own individual properties.

Docusaurus Slash Introduction

note

Note: Here, every source demands a different type of property, where Client DI, Client Secret, and Refresh Tokens are common in most sources. on that we can say, all the sources are different from each other.

  1. Set up source Form overview:

  • Name: Users can add the name of the source as per their requirements.

  • Github Repositoies name: The user has to select the source type from the provided list by airbyte.

  • Start Date: You can add current date here.

  • Access Token: You can add the access token, which you have generated from the github

    Github repository

  1. After adding the information, click on Set up Connection, it will test the connection here, then it will redirect to add destination of the source.

  2. After testing the connection successfully add the destination here.

Docusaurus Slash Introduction

  • Here, on the source adding screen,
  • The top-menu bar shows two buttons where
    1. for Overview of the source and
    2. for the settings of the source.
  • Overview: The overview screen shows the details related to the source; it may be empty as per the above screen.
  • Settings: From settings, the user can edit the form details of the added source.
  • Add destination button leads us to the destination page from the source page.
  1. Click on the Destination from the Top-right corner, as shown in the figure below:
note

It’s will show the available destinations, here user can add the new destination as per required.

Docusaurus Slash Introduction

info

To know more about adding the required destination in Airbyte go to the Destination

  1. Click on the MySQL Training here. it may take some time to fetch the stream names, as shown in figure below:

Docusaurus Slash Introduction

  1. After loading all the Streams form the Vendor’s to the destination, the destination page looks as shown in the figure below:

Docusaurus Slash Introduction

  1. After loading all the data streams user need to add Sync frequency and Table Prifix, as shown in the figure below:
  • Add Sync Frequency: Every Hour
  • Add Table Prefix: github_ 'It's an optional field, where users can add prefix just to recognize the table name easily.'
  • As shown in the figure below:

Docusaurus Slash Introduction

• When the user add the prefix, it gets added on Destination stream name automatically, as shown in the figure below:

Docusaurus Slash Introduction

  1. At the bottom of the destination page, we have two radio buttons, which contain the Normalization option. Keep the Basic Normalization selected.

Docusaurus Slash Introduction

  1. Now, click on the setup connection button to complete the connection. it will test the connection again which may take some time.
  2. Now, to validate the data is synced by the Airbyte, Go to the Connection from the Left menu bar of the screen:

Docusaurus Slash Introduction

  1. Find the Added connection of the github from the list and click on it.

Docusaurus Slash Introduction

  1. Here the github connection page will show the Status of the data sync and sync history.

Docusaurus Slash Introduction

  1. The title of the source and destination name.
  2. Status and settings page top menu bar.
  3. Enable button: from this button, the user can enable/disable the source from the destination.
  4. Reset your data and Sync button: the user can reset their data and only sync the updated data from the vendor.
  1. Click on the sync button to sync the data manually, after clicking on the sync button, it will start the process which will indicate the status under the history grid.
info

Once it gets completed it will indicate as the Succeeded under the history, as it will also indicate the size of data records number and time of sync. Here we have added the sync time as every hour, on that the Airbyte will sync the data in every hour automatically which will be shown as the figure below:

Docusaurus Slash Introduction